home *** CD-ROM | disk | FTP | other *** search
/ Freaks Macintosh Archive / Freaks Macintosh Archive.bin / Freaks Macintosh Archives / IRC / clients / smIRCle-PPC.sit.bin / smIRCle-PPC.sit / smIRCle PPC.rsrc / TEXT_128_ircle Help.txt < prev    next >
Text File  |  1999-04-08  |  15KB  |  197 lines
  1. Help for smIRCle
  2.  
  3. This is smIRCle, a Macintosh-based, windowed user interface to the Internet Relay Chat (IRC) network. 
  4.  
  5. This window contains:
  6. 0. Brief Overview on IRC
  7. 1. ircle Basics and Windows
  8. 2. IRC Commands and ircle Menus
  9. 3. Hints & Advice
  10. 4. General notes, Copyright Notice
  11. 5. History
  12. 6. Acknowlegdements & Credits
  13.  
  14.  
  15. 0. Brief Overview on IRC
  16.  
  17. (If you know IRC, skip this section)
  18. IRC is a multi-user online chatting system. It allows users to talk to other users all around the world via the Internet. This is done by connecting a client program (such as this one) to a server. You need a connection to any network connected to the Internet and running TCP/IP, and the MacTCP network driver. You have to find out your preferred server (usually the nearest) and enter this into the Preferences dialog. The port number used by IRC servers is usually 6667.
  19. On IRC, users are identified by nicknames of their own choice. Nicknames may be at most 9 characters long.  The nickname is set via preferences or the NICK command (s.b.) If you choose a nickname already in use, you have to set a different nick. Some users have registered their nicknames with the NickServ database. If you get a message from NickServ that your nick is in use, please choose another.
  20. Communication on IRC is done via Channels and Private Messages. Channels have names starting with # and usually up to 12 characters long. You can see a list of the channels currently in use via the /LIST command. As soon as you join a channel with the /JOIN command, everything you type is sent to that channel and seen by all other users on that channel. You will see what the others type, respectively.
  21.  
  22.  
  23. 1. ircle Basics and Windows
  24.  
  25. ircle has a user interface similar to the traditional text-oriented IRC clients. If you know IRC, you will find it familiar. At the bottom of the screen is the input line in an own small window which also carries a line of status information. Everything you type will appear in the input line. When you press Return, the line gets sent to the current channel or, if it contains a command, that command is processed. A line is considered command if it starts with a '/' (slash). You can change this character with the /cmdchar command. See Section 2 on commands.
  26. You connect to the server via Open conection in the File menu. When the connection to the server is established, the main message window will appear. This window has your nickname in the title bar. 
  27. As soon as you join a channel, a channel window will appear with the channel name as its title. All communication done in that channel will appear in that window. If you close this window, you leave the channel.
  28. Querying a user (s.b.) will open a user window. All private messages from and to that user will appear in this window.
  29. You can switch between windows using the mouse or Command-, (comma) key. The destination of text that you type is always determined by the frontmost window, i.e. the text goes to the channel or user whose name is the frontmost window's title.
  30. The number of windows open at a time is limited only by your computer's memory and your capability of listening at many sources at a time :-)
  31. All messages not coming from or related to a channel or queried user will appear in the main message window. That can include long lists from certain commands. You can skip these by pressing Command-. (dot).
  32.  
  33.  
  34. 2. IRC Commands and ircle Menus
  35.  
  36. Traditionally, IRC is controlled by typing commands. A line starting with a slash is considered a command. ircle has implemented this behaviour instead of a mouse-driven environment for simplicity and user-interface compatibility to other IRC clients. Certain frequently used commands can be reached via menus. These, however, do just paste the commands into the input line and thus are shortcuts for typing the commands.
  37. The File menu has items for opening a connection, closing the topmost window (this will leave a channel), loading commands from a file, saving the current state (s.b.), setting Preferences, opening/closing a logfile and the Quit command.
  38. The Edit menu has the Copy and Paste items. Text in a window can be selected and copied, then pasted into the input line.
  39. The Commands menus contain selected IRC commands. They get just pasted into the input line and are shortcut for convenience.
  40. The Shortcuts menu provides a means for user-defined shortcuts. They can be defined in a dialog box and called via Command-0 through 9. Note that new settings work only after closing the definitions dialog.
  41. The Font menu lets you set your preferred font and size. This will affect the currently active window and all new windows opened afterwards. It also gets stored in the Set file.
  42. The Windows menu contains the titles of the active windows for fast selection.
  43.  
  44. Preferences settings and Set files
  45.  
  46. Preferences settings are stored in a Set file (formerly called Preferences file). You can start ircle with particular settings by double-clicking on the Set file. This file contains some special commands. You can view and edit this file like a text file; in particular, you can write commands into it, which will be executed on startup.
  47. The settings in the Preferences dialog are:
  48. Server: The server you want to connect to. This has to be a numeric IP address or a full host.domain name.
  49. Port: Usually 6667, when in doubt check with your server administrator.
  50. Nickname: The nickname you want to start with.
  51. Mail address: You should specify your login name or mail address on a fully qualified (with domain) machine.
  52. Real name: Your real name (or whatever evil thing you want to look like your real name)
  53. Notifications: when messages appear in an inactive window, or in any window while ircle is running in the background, you will get alerted by a sound and/or blinking menu bar item, as you can select by checking these boxes.
  54. If you choose Save Set from the File menu, your settings will be saved into a file. This includes all windows you have open, so on next startup you will join these channels.
  55.  
  56. Description of IRC Commands
  57.  
  58. The following commands are currently available: (x) = untested. 
  59. * = operator command, untested and opers should know them anyway :-)
  60. /admin nick 
  61.        server      Shows administrative info
  62. /away message      Marks you as being away (no message = not away)
  63. /bye message       Displays message and quits IRC
  64. /broadcast message Sends a message to all of your windows
  65. /channel channel   Join a channel
  66. /cmdchar c         Changes the command-prefix (default /) to the given character
  67. /connect           * Connect two servers
  68. /cping nick        Shows response time for nick
  69. /ctcp target command  Issues a CTCP command. Do /ctcp target clientinfo for more info.
  70. /date              display date/time (x)
  71. /dcc command nick  Issues a DCC command (explained below).
  72. /die               * Shut down a server
  73. /exit message      =/bye
  74. /hash              * Reconfigure a server
  75. /host              (x)
  76. /ignore pattern    ignore messages from nick!user@host (may contain wildcards)
  77.         +pattern   ignore and give the ignored a notice
  78.         -pattern   removes a pattern from the ignore list
  79. /info              gives info about server
  80. /invite nick channel invites nick to channel
  81. /join channel      =/channel
  82. /kick channel nick kicks nick from channel
  83. /kill nick         * kicks nick out of IRC
  84. /leave channel     leave a channel
  85. /links             show server connections
  86. /list              list channels
  87.       -min n       list only channels with minimum of n users
  88.       -max n                          ...  maximum of n users
  89.       -public      list only public channels
  90.       -private           ... private channels
  91.       -local             ... local channels
  92.       -global            ... global channels
  93.       -topic             ... channels with topic
  94. /lusers            display statistics
  95. /me action         sends an action description
  96. /mode channel par  set channel mode
  97.               +p   private channel
  98.               +s   secret channel
  99.               +i   invite-only channel
  100.               +m   moderated channel
  101.               +n   no messages from outside channel
  102.               +t   only channel op may set topic
  103.               +l n channel may hold at most n users
  104.         +v nick    let nick speak on moderated channel
  105.         +b nick    ban nick
  106.         +k key     set channel password
  107.         +o nick    nick becomes channel op
  108.               -x   removes flag x, where x is one of the above
  109. /mode nick par     set user mode
  110.               +i   invisible user
  111.               +s   receive server notices
  112.               +w   receive wallops
  113. /motd              show message-of-the-day
  114. /msg nick message  Sends a private message
  115. /names channel     List users on channel
  116. /nick newnick      Change your nickname
  117. /note              (x)
  118. /notice            (almost) like /msg
  119. /notify nick       Adds nick to notification list (show each signon/off)
  120.         -nick      removes nick from notification list
  121. /oper              become operator *
  122. /part channel      =/leave
  123. /query nick        open window for private messages to nick
  124. /quit message      =/bye
  125. /rehash            * Reconfigure a server
  126. /restart           * Restart a server
  127. /server srvadr     Switch to a different server
  128. /show x y          Suppress (y=OFF) or allow (y=ON) displaying of certain messages
  129.                    x is one of: join,part,quit,topic,invite,nick,mode,kick,names, or all. 
  130. /signoff message   =/bye
  131. /squit             * Remove a link between servers
  132. /stats             * Statistical info
  133. /summon user@host  Invites user@host to IRC (host must be running a server)
  134. /time              =/date
  135. /topic channel text Set a channel topic
  136. /trace             (x)
  137. /type              Type a text file to the current channel
  138. /users             (x)
  139. /version           Show server version
  140. /wallops message   Message to all operators (deprecated)
  141. /who channel       List people on channel
  142. /whois nick        Give information about user
  143. /whowas nick       Give information about user having gone
  144.  
  145. Valid commands for /dcc are:
  146. chat  - requests CHAT connection for nick or answers such a request
  147. send - send a file; tsend - send a text file
  148. get - receive a file (to be answered to a SEND request); tget - receive a text file
  149. list - list all DCC connections.
  150.  
  151.  
  152. 3. Hints & Advice
  153.  
  154. More information on IRC commands can be found in the 'ircle Users manual' and 'IRC Advice' files and probably in the help files for the IRCII client (but note that IRCII has a number of commands for programmability that ircle has not).
  155. When selecting a non-proportional font keep in mind that IRC was originally designed for text terminals and some commands and messages assume a fixed-size screen. That may make output look strange in some situations.
  156. This client uses the ISO Latin-1 8-bit character set and converts Macintosh special characters to this code. Some characters can not be converted and will be mapped to nonsensical characters. This also holds for DCC tsend/tget which are text-mode versions of send/get. The conversion table are those also used by Peter Lewis' FTPd.
  157. New users should check the file 'IRC Advice'.
  158.  
  159.  
  160. 4. General notes, Copyright Notice
  161.  
  162. THIS PROGRAM IS NOT IN THE PUBLIC DOMAIN!
  163. It was written by Johannes Jander (jander@neuro.biologie.fu-berlin.de), starting Dec 1996 and is therefore copyrighted by me. Main parts and concept by Olaf Titz (s_titz@ira.uka.de), July 1992-July 1993, who holds the copyright for those parts. 
  164. You may use, copy and distribute it under the terms and conditions of the GNU General Public License, see the file COPYING that should have accompanied this program. Be sure to include the file COPYING when distributing this program.
  165.  
  166. Copyright (c) 1996,97 Johannes Jander (jander@neuro.biologie.fu-berlin.de).
  167. Original coding and design copyright (c) 1992,93 Olaf Titz (s_titz@ira.uka.de).
  168. Some parts of this program written by Peter N. Lewis, (C) 1992.
  169. Written and compiled using Codewarrior 10 (Metrowerks).
  170.  
  171. THIS PROGRAM IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO CASE SHALL THE PRODUCER OF THIS PROGRAM BE HELD LIABLE FOR ANY MALFUNCTION OF THE PROGRAM.
  172.  
  173. System requirements: any Mac with System version 7.0 and higher and the MacTCP driver.
  174.  
  175. This client is to fit version 2.7 and 2.8 servers. All commands and features obsoleted by 2.7 are taken out (as should be all obsolete servers by now). This client is fully compatible with the RFC1459 standard for IRC.
  176. I have still not testes all commands and special cases; there may still be some bugs, feel free to report them to me (or the alt.irc newsgroup).
  177.  
  178.  
  179. 5. History
  180.  
  181. smIRCle is based on the concept of a small IRC client written in 92/93. I called this ircle with a German -le suffix and spelled uncapitalized because it is rather small, and I did not put too much work into it (O. Titz). It was the basis of a very successful shareware client ( still named ircle) by Onno Tijdgat. In order to make available to the public a freeware client again, I ( J. Jander) took the code in 96 and ported it to PowerMac, thereby adding some features. I still keep a focus on producing a lightweight client rather than a >1MB 'fat' application. There are certainly IRC clients with much more functionality around, but this one runs in Mac windows, and after all, it seems to work. In order to avoid confusion with Onnos excellent client I renamed this one to smIRCle, wishing to express that it is a friendly and at the same time small program.
  182. If you find any flaws in the working of the program, or wish to express your opinion about it, send a mail to snow@starmail.com. Send hate mail, flames and ramblings about the superiority of other clients or operation systems to root@[127.0.0.1] please. Apart from that I wellcome suggestions, but I dont make any promises about implementing anything. This is a project I do strictly in my spare-time, so if you have any break-through ideas, grab the code and implement them!
  183.  
  184.  
  185. 6. Acknowledgements & Credits
  186.  
  187. smIRCle is a big 'thank you' to Olaf, whose original ircle gave me some fine hours on the net.
  188. This program uses the (outdated) TCP-interfaces by Peter 'Network' Lewis.
  189. Some interface ideas stolen from Homer, MacIRC, Snak, mIRC and ircle 3.
  190. Floating window support by a piece of code from F. Pottier.
  191. Live Scrolling of channel text from a snippet by Jean-Yves Bernier.
  192. Drag-n-Drop support by a piece from Greg Robbins.
  193. CDEFs modified from Jim Stouts and Paul Celestins.
  194. LDEF code based on Matt Slot's.
  195. Some code snippets from the net are shamelessly integrated without proper credits ;)
  196.  
  197. Have fun!